GetFolderName

GetFolderName
Header:	Folders.h		Carbon status:	Supported

Obtains the name of the specified folder.

OSErr GetFolderName (
    SInt16 vRefNum, 
    OSType foldType, 
    SInt16 *foundVRefNum, 
    StrFileName name
);

Parameter descriptions

vRefNum: Pass the volume reference number (or the constant kOnSystemDisk for the startup disk) of the volume containing the folder for which you wish the name to be identified.
foldType: Pass a constant identifying the type of the folder for which you wish the name to be identified. See “Folder Type Constants”.
foundVRefNum: On return, a pointer to the volume reference number for the volume containing the folder specified in the foldType parameter.
name: On return, a string containing the title of the folder specified in the foldType and vRefNum parameters.

function result: A result code.

DISCUSSION

The GetFolderName function obtains the name of the folder in the folder descriptor, not the name of the folder on the disk. The names may differ for a few special folders such as the System Folder. For relative folders, however, the actual name is always returned. You typically do not need to call this function.

VERSION NOTES

This function is supported under Mac OS 8 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.